// Copyright (C) Kumo inc. and its affiliates.
// Author: Jeff.li lijippy@163.com
// All rights reserved.
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//


#pragma once

namespace kumo::pollux::dwio::common {
    struct StripeProgress {
        uint32_t stripeIndex{0};
        uint64_t stripeRowCount{0};
        int64_t totalMemoryUsage{0};
        /// Hides the first stripe special case in customer side.
        int64_t stripeSizeEstimate{0};
    };

    // Specific formats can extend this interface to do additional
    // checks and customize how the decisions are combined.
    class FlushPolicy {
    public:
        virtual ~FlushPolicy() = default;

        virtual bool shouldFlush(const StripeProgress &stripeProgress) = 0;

        // The flush policy might need to trigger external side effects upon
        // writer close. e.g. signaling to a coorditor of concurrent writers.
        virtual void onClose() = 0;
    };
} // namespace kumo::pollux::dwio::common
